.\" t
.TH "clnetctl" "1M" "Jun 28, 2006" "1\&.2\&.0"
.SH NAME
lemsctl \- Pass messages to a Linuxha.net Network Daemon

.SH SYNOPSIS
.TS
l.
clnetctl \fB-M|--msg\fP \fImsg\fP [\fB--verbose\fP] [\fB--nochecksums\fP]
       Pass message to Linuxha.net Network Daemon

clnetctl \fB-?\fP
       Show brief usage information
.TE

.SH DESCRIPTION
This utility allows the administrator to send a message to the Network 
daemon running on the local node [one runs on each node].
not currently running an error will be returned.

Once the message has been dealt with the output will be sent to the 
standard output. The message may consist one or more lines of output, 
depending on the request. If the message consists of more than one word 
[and thus contains white space], it should be placed in quotes.

.SH COMMON MESSAGES
This list of supported messages that can be sent to the daemon varies
depending on the software release. However the list below is supported for
all recent releases (from 1.0.0 onwards).

.TP 4
.B ABORT
When this message is sent to the daemon it will immediately exit.
.TP
.B REREAD
This reloads the configuration that the daemon is working to. This is
necessary if the cluster topology changes [i.e. network configuration
changes]. It is automatically called if the \fIclbuild(1M)\fP routine is
called when the cluster is up and running.
.TP
\fBIGNORE\fP NET=name
Allows monitoring of the cards associated with the given network
to be stopped. This is useful if actions should as cable changes are to
take place for the NIC's used by the particular network.
.TP
\fBMONITOR\fP NET=name
This is the opposite of the \fBIGNORE\fP command - it turns on monitoring
for the particular network. 
.TP
\fBMIGRATE\fP NET=name [SILENT=1] [CARD=ethN]
This performs a IP migration for the specified network. If the \fBSILENT\fP 
option is used no logging of the changes that occur take place, whilst the 
\fBCARD\fP argument can be used to force it to use a particular card. If the
\fBCARD\fP option is not used it will either use a card it has never used 
before, or the cause it used to longest time ago.
.TP
\fBSTATUS\fP [NET=name]
Return statistics for all networks, or limited just to a specified 
network of the \fBNET\fP argument is used. Each network will be 
represented by a separate line. Each line consists of colon-separated
entries for the following fields:

net:monitor:mii:livecard:goodcards:monitor:NA|rbytes,wbytes

.RS 4
.TP 6
.B net
The name of the network.
.TP
.B monitor
Set to '1' if the network is being monitored, or '0' if monitoring is
not occurring.
.TP
.B livecard
The name of the card that is currently hosting the IP addresses associated
with this network.
.TP
.B goodcards
A comma-separated list of card names that are thought to be suitable to
failing over to if a problem occurs with the current card. The order
of the cards given does not correlate to the order of choosing the next card
if the current one fails.
.TP
.B monitor
Repeat of the previous field [a bug, but kept for compatibility reasons].
.TP
.B performance
If the monitor has been running for less than 30 seconds on a particular
card this will be set to 'NA'. Otherwise it will be a two values, comma-
separated. The first is the Kbytes/second read performance over a 30 second
period, and second is the write performance in Kbytes/second for the same
period.
.RE

.SH ARGUMENTS
Only a small number of options are currently available.

.TP 8
.B --verbose
Gives some output to the standard output regarding the operation of the
command - nothing of any real detail is currently produced, however.
.TP
.B --msg
The message to send to the network daemon on the local machine.
.TP
.B --nochecksums
Normally if the cluster or application configuration file 
have been modified whilst the cluster is running the
checksums which are used to indicate the last sane and checked configuration 
will not be valid. In such instances many of the Linuxha.net commands, including
this will not will not function. If necessary the \fB--nochecksums\fP can be
used to overcome this until the cluster or application configuration are
next rebuilt.

.SH EXIT STATUS
The \fIclnetctl(1M)\fP utility makes use of many error codes, but in summary
it will return a non-zero number for an error or zero if the message was
past to the Network daemon and the response was returned.

Please note that if the command "failed" on the Network daemon but it managed
to send a response then the \fIclnetctl(1M)\fP will return a successful
exit code.

.SH SEE ALSO
.TS
l l.
cldeamonctl(1M)	- Cluster status Daemon Communication Tool
clhbdctl(1M)	- Heartbeat Daemon Communication Tool
clstat(1M)	- Show cluster status information
appconf.xml(5)	- Configuration of an application used by the cluster
clconf.xml(5)	- Overall cluster topology configuration file
lems.xml(5)	- Lems Daemon configuration file
.TE

.SH AUTHOR
The \fIclnetsctl(1M)\fP utility was written by Simon Edwards, 2004-2006. The
author can be contacted via the website mentioned below.

.SH AVAILABILITY
This software is freely available from the Linuxha.net website - please see
\fBhttp://www.linuxha.net\fP for more details.

.SH WARRANTY
This is Open Source Software is per the GNU GPL. It is free to use and
distribute but \fIcomes with no warranty whatsoever\fP. For more information
on the license please see \fBwww.gnu.org/copyleft/gpl.html\fP.

